<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page index.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name">/gui/index.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-classes">Classes</a>
			|									<a href="#sec-constants">Constants</a>
			|									<a href="#sec-functions">Functions</a>
			</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Bridge: A Modular uTorrent WebUI Bridge</p>
<p class="description"><p>Provides uTorrent client support for non-native server backends.</p></p>
	<ul class="tags">
				<li><span class="field">version:</span> 0.1.2</li>
				<li><span class="field">copyright:</span> Copyright (c) 2009,                  Ryon Sherman &lt;ryon.sherman@gmail.com&gt;</li>
				<li><span class="field">filesource:</span> <a href="../__filesource/fsource_bridge__guiindex.php.html">Source Code for this file</a></li>
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.txt">The GNU Public License</a></li>
			</ul>
		
			</div>
</div>
		
	<a name="sec-classes"></a>	
	<div class="info-box">
		<div class="info-box-title">Classes</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Classes</span>
			|										<a href="#sec-constants">Constants</a>
				|													<a href="#sec-functions">Functions</a>
					</div>
		<div class="info-box-body">	
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top">
						<a href="../bridge/utb_bridge.html">utb_bridge</a>
					</td>
					<td>
											Bridge Class
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top">
						<a href="../bridge/server/utb_server_interface.html">utb_server_interface</a>
					</td>
					<td>
											Server Interface
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top">
						<a href="../bridge/transfer/utb_transfer.html">utb_transfer</a>
					</td>
					<td>
											Transfer Container
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top">
						<a href="../bridge/property/utb_properties.html">utb_properties</a>
					</td>
					<td>
											Transfer Properties Container
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; vertical-align: top">
						<a href="../bridge/file/utb_file.html">utb_file</a>
					</td>
					<td>
											File Container
										</td>
				</tr>
							</table>
		</div>
	</div>

	
	<a name="sec-constants"></a>	
	<div class="info-box">
		<div class="info-box-title">Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-classes">Classes</a>
				|									<span class="disabled">Constants</span>
			|										<a href="#sec-functions">Functions</a>
					</div>
		<div class="info-box-body">	
			<a name="defineFILE_LOG"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">FILE_LOG</span> = 'log.txt'
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a40">40</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log File</p>
<p class="description"><p>Location of log file.</p></p>
	<ul class="tags">
				<li><span class="field">internal:</span> Relative or absolute path</li>
			</ul>
	
		
</div>
<a name="defineSERVER_MODULE"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">SERVER_MODULE</span> = 'rtorrent'
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a31">31</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Server Module</p>
<p class="description"><p>Module used for server interaction.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../bridge/server/utb_server_interface.html">utb_server_interface</a></li>
				<li><span class="field">internal:</span> Modules located in &quot;./servers/*&quot;</li>
			</ul>
	
		
</div>
<a name="defineSERVER_URL"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">SERVER_URL</span> = 'http://localhost/'
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a21">21</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Server URL</p>
<p class="description"><p>Connection string of non-native server to bridge.</p></p>
	<ul class="tags">
				<li><span class="field">internal:</span> Include trailing forward-slash.</li>
			</ul>
	
		
</div>
<a name="defineUTORRENT_BOOLEAN_DISABLED"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_BOOLEAN_DISABLED</span> = -1
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a60">60</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Boolean: Disabled</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Disabled&quot; boolean value.</p></p>
	
		
</div>
<a name="defineUTORRENT_BOOLEAN_FALSE"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_BOOLEAN_FALSE</span> = 0
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a67">67</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Boolean: False</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;False&quot; boolean value.</p></p>
	
		
</div>
<a name="defineUTORRENT_BOOLEAN_TRUE"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_BOOLEAN_TRUE</span> = 1
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a74">74</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Boolean: True</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;True&quot; boolean value.</p></p>
	
		
</div>
<a name="defineUTORRENT_BUILD"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_BUILD</span> = 16150
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a53">53</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Build</p>
<p class="description"><p>Last supported uTorrent Build.</p></p>
	<ul class="tags">
				<li><span class="field">internal:</span> Integer value required</li>
			</ul>
	
		
</div>
<a name="defineUTORRENT_DATA_TYPE_BOOLEAN"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_DATA_TYPE_BOOLEAN</span> = 1
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a88">88</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Data Type: Boolean</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Boolean&quot; data type.</p></p>
	
		
</div>
<a name="defineUTORRENT_DATA_TYPE_INTEGER"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_DATA_TYPE_INTEGER</span> = 0
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a81">81</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Data Type: Integer</p>
<p class="description"><p>Integer value used by uTorrent to represent an &quot;Integer&quot; data type.</p></p>
	
		
</div>
<a name="defineUTORRENT_DATA_TYPE_STRING"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_DATA_TYPE_STRING</span> = 2
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a95">95</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Data Type: String</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;String&quot; data type.</p></p>
	
		
</div>
<a name="defineUTORRENT_PRIORITY_EXCLUDE"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_PRIORITY_EXCLUDE</span> = 0
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a158">158</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Priority: Exclude</p>
<p class="description"><p>Integer value used by uTorrent to represent an &quot;Exclude&quot; priority.</p></p>
	
		
</div>
<a name="defineUTORRENT_PRIORITY_HIGH"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_PRIORITY_HIGH</span> = 3
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a179">179</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Priority: High</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;High&quot; priority.</p></p>
	
		
</div>
<a name="defineUTORRENT_PRIORITY_LOW"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_PRIORITY_LOW</span> = 1
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a165">165</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Priority: Low</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Low&quot; priority.</p></p>
	
		
</div>
<a name="defineUTORRENT_PRIORITY_NORMAL"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_PRIORITY_NORMAL</span> = 2
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a172">172</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Priority: Normal</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Normal&quot; priority.</p></p>
	
		
</div>
<a name="defineUTORRENT_STATUS_CHECKED"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_STATUS_CHECKED</span> = 8
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a123">123</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Status: Checked</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Checked&quot; status.</p></p>
	
		
</div>
<a name="defineUTORRENT_STATUS_CHECKING"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_STATUS_CHECKING</span> = 2
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a109">109</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Status: Checking</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Checking&quot; status.</p></p>
	
		
</div>
<a name="defineUTORRENT_STATUS_CHECK_START"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_STATUS_CHECK_START</span> = 4
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a116">116</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Status: Check Before Starting</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Check Before Starting&quot; status.</p></p>
	
		
</div>
<a name="defineUTORRENT_STATUS_ERROR"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_STATUS_ERROR</span> = 16
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a130">130</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Status: Error</p>
<p class="description"><p>Integer value used by uTorrent to represent an &quot;Error&quot; status.</p></p>
	
		
</div>
<a name="defineUTORRENT_STATUS_LOADED"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_STATUS_LOADED</span> = 128
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a151">151</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Status: Loaded</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Loaded&quot; status.</p></p>
	
		
</div>
<a name="defineUTORRENT_STATUS_PAUSED"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_STATUS_PAUSED</span> = 32
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a137">137</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Status: Paused</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Paused&quot; status.</p></p>
	
		
</div>
<a name="defineUTORRENT_STATUS_QUEUED"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_STATUS_QUEUED</span> = 64
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a144">144</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Status: Queued</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Queued&quot; status.</p></p>
	
		
</div>
<a name="defineUTORRENT_STATUS_STARTED"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="const-title">
			<span class="const-name">UTORRENT_STATUS_STARTED</span> = 1
			(line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a102">102</a></span>)
		</span>
	</div>
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">uTorrent Status: Started</p>
<p class="description"><p>Integer value used by uTorrent to represent a &quot;Started&quot; status.</p></p>
	
		
</div>
		</div>
	</div>
	
	
	<a name="sec-functions"></a>	
	<div class="info-box">
		<div class="info-box-title">Functions</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-classes">Classes</a>
				|													<a href="#sec-constants">Constants</a>
				|									<span class="disabled">Functions</span>
		</div>
		<div class="info-box-body">	
			<a name="functionutb_error_handler" id="functionutb_error_handler"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">utb_error_handler</span> (line <span class="line-number"><a href="../__filesource/fsource_bridge__guiindex.php.html#a208">208</a></span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Custom Error Handler</p>
<p class="description"><p>Logs PHP errors to file.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Continue to default error handler</li>
				<li><span class="field">author:</span> ryon.sherman</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">false</span>
		<span class="method-name">
			utb_error_handler
		</span>
					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$error_level</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$error_string</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$error_file</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$error_line</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$error_level</span><span class="var-description">: Level of error</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$error_string</span><span class="var-description">: Error message</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$error_file</span><span class="var-description">: File where error occured</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$error_line</span><span class="var-description">: Line where error occured</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Wed, 16 Dec 2009 10:32:54 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>